Skip to content

5.0: Build REST API Ref W/ PHP API Ref #2744

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 54 commits into from
Jul 22, 2025
Merged

5.0: Build REST API Ref W/ PHP API Ref #2744

merged 54 commits into from
Jul 22, 2025

Conversation

adriendupuis
Copy link
Contributor

@adriendupuis adriendupuis commented May 14, 2025

Question Answer
JIRA Ticket IBX-9904
Versions 5.0
Edition Commerce

5.0 REST API Reference is build from API Platform / OpenAPI.
Merge PHP API and REST API References builds.
(It was theorized in #2723.)

The workflow will always be called from repo default branch. It will checkout the doc branch according to the version input and run the proper tool for 4.6 and "other than 4.6" (so, 5.x+).

v5.0.0-rc1 test

gh workflow run api_refs.yaml -f version='v5.0.0-rc1' --ref=5.0-api-refs;
Success in https://github.com/ibexa/documentation-developer/actions/runs/16344392797/job/46174303137 while on commit a02cc3f which opened the PR #2833

v5.0.0 test

Manually triggered https://github.com/ibexa/documentation-developer/actions/runs/16448573970/job/46487257912 is a success and created a correct #2842 even if peter-evans/create-pull-request@v7 job ended as a fail (Error: Server Error)

About maintenance

When 5.0 tool is modified, to update 4.6 accordingly isn't easy. And vice-versa.

We can use git diff like this (eventually with current HEAD instead of one of branch names):

git diff 4.6:tools/php_api_ref/phpdoc.sh 5.0:tools/api_refs/api_refs.sh
git diff 4.6:tools/php_api_ref/.phpdoc 5.0:tools/api_refs/.phpdoc

Or I can rename on 4.6 side as well…

Checklist

  • Text renders correctly
  • Text has been checked with vale
  • Description metadata is up to date
  • Redirects cover removed/moved pages
  • Code samples are working
  • PHP code samples have been fixed with PHP CS fixer
  • Added link to this PR in relevant JIRA ticket or code PR

@adriendupuis adriendupuis marked this pull request as draft May 14, 2025 07:08
Copy link

Preview of modified files: no change to preview.

@mnocon mnocon changed the base branch from master to 5.0 May 19, 2025 07:24
# Conflicts:
#	docs/api/rest_api/rest_api_reference/input/ibexa-cart.raml
#	docs/api/rest_api/rest_api_reference/input/ibexa-corporate.raml
#	docs/api/rest_api/rest_api_reference/input/ibexa-types.raml
#	docs/api/rest_api/rest_api_reference/input/ibexa-user-users.raml
#	docs/api/rest_api/rest_api_reference/input/ibexa.raml
#	tools/api_refs/.phpdoc/template/menu-entry.html.twig
#	tools/api_refs/.phpdoc/template/menu.html.twig
#	tools/api_refs/.phpdoc/template/package-edition-map.twig
#	tools/api_refs/api_refs.sh
#	tools/raml2html/themes/default/index.html.twig
fatal: pathspec 'tools/api_refs/.phpdoc/template/package-edition-map.twig' did not match any files
adriendupuis and others added 3 commits July 22, 2025 15:06
* PHP API Ref HTML
* REST API Ref HTML

---------

Co-authored-by: adriendupuis <[email protected]>
@adriendupuis adriendupuis marked this pull request as ready for review July 22, 2025 16:35
@adriendupuis adriendupuis merged commit be0260a into 5.0 Jul 22, 2025
3 of 6 checks passed
@adriendupuis adriendupuis deleted the 5.0-api-refs branch July 22, 2025 16:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants